home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / tmpl / gimpunitmenu.sgml < prev    next >
Encoding:
SGML Document  |  2003-05-20  |  2.1 KB  |  123 lines
  1. <!-- ##### SECTION Title ##### -->
  2. GimpUnitMenu
  3.  
  4. <!-- ##### SECTION Short_Description ##### -->
  5. Widget for selecting a #GimpUnit.
  6.  
  7. <!-- ##### SECTION Long_Description ##### -->
  8. <para>
  9. This widget provides a #GtkOptionMenu which contains a list of #GimpUnit's.
  10. </para>
  11. <para>
  12. You can specify the string that will be displayed for each unit by
  13. passing a printf-like @format string to gimp_unit_menu_new().
  14. </para>
  15. <para>
  16. The constructor also lets you choose if the menu should contain items
  17. for GIMP_UNIT_PIXEL, GIMP_UNIT_PERCENT and a "More..." item which will
  18. pop up a dialog for selecting user-defined units.
  19. </para>
  20. <para>
  21. Whenever the user selects a unit from the menu or the dialog, the
  22. "unit_changed" signal will be emitted.
  23. </para>
  24.  
  25. <!-- ##### SECTION See_Also ##### -->
  26. <para>
  27. #GimpUnit
  28. </para>
  29. <para>
  30. #GimpSizeEntry
  31. </para>
  32.  
  33. <!-- ##### STRUCT GimpUnitMenu ##### -->
  34. <para>
  35.  
  36. </para>
  37.  
  38.  
  39. <!-- ##### MACRO GIMP_UNIT_MENU ##### -->
  40. <para>
  41. Checks if the passed pointer is a pointer to a #GimpUnitMenu and
  42. performs the cast if valid.
  43. </para>
  44.  
  45. @obj: The pointer to cast.
  46.  
  47.  
  48. <!-- ##### FUNCTION gimp_unit_menu_new ##### -->
  49. <para>
  50.  
  51. <informaltable pgwide=1 frame="none" role="enum">
  52. <tgroup cols="2"><colspec colwidth="1*"><colspec colwidth="8*">
  53. <tbody>
  54.  
  55. <row>
  56. <entry>% f</entry>
  57. <entry>Factor (how many units make up an inch)</entry>
  58. </row>
  59.  
  60. <row>
  61. <entry>% y</entry>
  62. <entry>Symbol (e.g. "''" for GIMP_UNIT_INCH)</entry>
  63. </row>
  64.  
  65. <row>
  66. <entry>% a</entry>
  67. <entry>Abbreviation</entry>
  68. </row>
  69.  
  70. <row>
  71. <entry>% s</entry>
  72. <entry>Singular</entry>
  73. </row>
  74.  
  75. <row>
  76. <entry>% p</entry>
  77. <entry>Plural</entry>
  78. </row>
  79.  
  80. <row>
  81. <entry>%%</entry>
  82. <entry>Literal percent</entry>
  83. </row>
  84.  
  85. </tbody></tgroup></informaltable>
  86.  
  87. </para>
  88.  
  89. @format: 
  90. @unit: 
  91. @show_pixels: 
  92. @show_percent: 
  93. @show_custom: 
  94. @Returns: 
  95.  
  96.  
  97. <!-- ##### FUNCTION gimp_unit_menu_set_unit ##### -->
  98. <para>
  99.  
  100. </para>
  101.  
  102. @gum: 
  103. @unit: 
  104.  
  105.  
  106. <!-- ##### FUNCTION gimp_unit_menu_get_unit ##### -->
  107. <para>
  108.  
  109. </para>
  110.  
  111. @gum: 
  112. @Returns: 
  113.  
  114.  
  115. <!-- ##### SIGNAL GimpUnitMenu::unit-changed ##### -->
  116. <para>
  117. This signal is emitted whenever the user selects a #GimpUnit from the
  118. #GimpUnitMenu.
  119. </para>
  120.  
  121. @gimpunitmenu: the object which received the signal.
  122.  
  123.